<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="null" lang="null">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" /><title>Context xref</title>
<link type="text/css" rel="stylesheet" href="../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../apidocs/org/jaxen/Context.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <strong>package</strong> org.jaxen;
<a name="2" href="#2">2</a>   
<a name="3" href="#3">3</a>   <em class="comment">/*</em>
<a name="4" href="#4">4</a>   <em class="comment"> $Id: Context.java 1219 2006-10-15 21:08:16Z elharo $</em>
<a name="5" href="#5">5</a>   
<a name="6" href="#6">6</a>   <em class="comment"> Copyright 2003 The Werken Company. All Rights Reserved.</em>
<a name="7" href="#7">7</a>   <em class="comment"> </em>
<a name="8" href="#8">8</a>   <em class="comment">Redistribution and use in source and binary forms, with or without</em>
<a name="9" href="#9">9</a>   <em class="comment">modification, are permitted provided that the following conditions are</em>
<a name="10" href="#10">10</a>  <em class="comment">met:</em>
<a name="11" href="#11">11</a>  
<a name="12" href="#12">12</a>  <em class="comment">  * Redistributions of source code must retain the above copyright</em>
<a name="13" href="#13">13</a>  <em class="comment">    notice, this list of conditions and the following disclaimer.</em>
<a name="14" href="#14">14</a>  
<a name="15" href="#15">15</a>  <em class="comment">  * Redistributions in binary form must reproduce the above copyright</em>
<a name="16" href="#16">16</a>  <em class="comment">    notice, this list of conditions and the following disclaimer in the</em>
<a name="17" href="#17">17</a>  <em class="comment">    documentation and/or other materials provided with the distribution.</em>
<a name="18" href="#18">18</a>  
<a name="19" href="#19">19</a>  <em class="comment">  * Neither the name of the Jaxen Project nor the names of its</em>
<a name="20" href="#20">20</a>  <em class="comment">    contributors may be used to endorse or promote products derived </em>
<a name="21" href="#21">21</a>  <em class="comment">    from this software without specific prior written permission.</em>
<a name="22" href="#22">22</a>  
<a name="23" href="#23">23</a>  <em class="comment">THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS</em>
<a name="24" href="#24">24</a>  <em class="comment">IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED</em>
<a name="25" href="#25">25</a>  <em class="comment">TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A</em>
<a name="26" href="#26">26</a>  <em class="comment">PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER</em>
<a name="27" href="#27">27</a>  <em class="comment">OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</em>
<a name="28" href="#28">28</a>  <em class="comment">EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,</em>
<a name="29" href="#29">29</a>  <em class="comment">PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR</em>
<a name="30" href="#30">30</a>  <em class="comment">PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF</em>
<a name="31" href="#31">31</a>  <em class="comment">LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING</em>
<a name="32" href="#32">32</a>  <em class="comment">NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</em>
<a name="33" href="#33">33</a>  <em class="comment">SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</em>
<a name="34" href="#34">34</a>  
<a name="35" href="#35">35</a>  <em class="comment"> */</em>
<a name="36" href="#36">36</a>  
<a name="37" href="#37">37</a>  <strong>import</strong> java.io.Serializable;
<a name="38" href="#38">38</a>  <strong>import</strong> java.util.ArrayList;
<a name="39" href="#39">39</a>  <strong>import</strong> java.util.Collections;
<a name="40" href="#40">40</a>  <strong>import</strong> java.util.List;
<a name="41" href="#41">41</a>  
<a name="42" href="#42">42</a>  <em>/**</em><em> Wrapper around implementation-specific objects used</em>
<a name="43" href="#43">43</a>  <em> *  as the context of an expression evaluation.</em>
<a name="44" href="#44">44</a>  <em> *</em>
<a name="45" href="#45">45</a>  <em> *  &lt;p></em>
<a name="46" href="#46">46</a>  <em> *  &lt;strong>NOTE:&lt;/strong> This class is not typically used directly,</em>
<a name="47" href="#47">47</a>  <em> *  but is exposed for writers of implementation-specific</em>
<a name="48" href="#48">48</a>  <em> *  XPath packages.</em>
<a name="49" href="#49">49</a>  <em> *  &lt;/p></em>
<a name="50" href="#50">50</a>  <em> *</em>
<a name="51" href="#51">51</a>  <em> *  &lt;p></em>
<a name="52" href="#52">52</a>  <em> *  The &lt;code>Context&lt;/code> bundles utilities together</em>
<a name="53" href="#53">53</a>  <em> *  for evaluation of the expression.  It wraps the provided</em>
<a name="54" href="#54">54</a>  <em> *  objects for ease-of-passage through the expression </em>
<a name="55" href="#55">55</a>  <em> *  &lt;acronym title="Abstract Syntax Tree">AST&lt;/acronym>.</em>
<a name="56" href="#56">56</a>  <em> *  &lt;/p></em>
<a name="57" href="#57">57</a>  <em> *</em>
<a name="58" href="#58">58</a>  <em> *  @see ContextSupport</em>
<a name="59" href="#59">59</a>  <em> *  @see BaseXPath</em>
<a name="60" href="#60">60</a>  <em> *  @see org.jaxen.dom4j.Dom4jXPath XPath for dom4j</em>
<a name="61" href="#61">61</a>  <em> *  @see org.jaxen.jdom.JDOMXPath  XPath for JDOM</em>
<a name="62" href="#62">62</a>  <em> *  @see org.jaxen.dom.DOMXPath   XPath for W3C DOM</em>
<a name="63" href="#63">63</a>  <em> *</em>
<a name="64" href="#64">64</a>  <em> *  @author &lt;a href="<a href="mailto:bob@werken.com" target="alexandria_uri">mailto:bob@werken.com</a>">bob mcwhirter&lt;/a></em>
<a name="65" href="#65">65</a>  <em> */</em>
<a name="66" href="#66">66</a>  <strong>public</strong> <strong>class</strong> <a href="../../org/jaxen/Context.html">Context</a> implements Serializable {
<a name="67" href="#67">67</a>      
<a name="68" href="#68">68</a>      <em>/**</em>
<a name="69" href="#69">69</a>  <em>     * </em>
<a name="70" href="#70">70</a>  <em>     */</em>
<a name="71" href="#71">71</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> <strong>long</strong> serialVersionUID = 2315979994685591055L;
<a name="72" href="#72">72</a>  
<a name="73" href="#73">73</a>      <em class="comment">// ----------------------------------------------------------------------</em>
<a name="74" href="#74">74</a>      <em class="comment">//     Instance members</em>
<a name="75" href="#75">75</a>      <em class="comment">// ----------------------------------------------------------------------</em>
<a name="76" href="#76">76</a>  
<a name="77" href="#77">77</a>      <em>/**</em><em> Context-support */</em>
<a name="78" href="#78">78</a>      <strong>private</strong> <a href="../../org/jaxen/ContextSupport.html">ContextSupport</a> contextSupport;
<a name="79" href="#79">79</a>  
<a name="80" href="#80">80</a>      <em>/**</em><em> <a href="../../org/jaxen/Context.html">Context</a> node-set */</em>
<a name="81" href="#81">81</a>      <strong>private</strong> List nodeSet;
<a name="82" href="#82">82</a>  
<a name="83" href="#83">83</a>      <em>/**</em><em> Current context size */</em>
<a name="84" href="#84">84</a>      <strong>private</strong> <strong>int</strong> size;
<a name="85" href="#85">85</a>  
<a name="86" href="#86">86</a>      <em>/**</em><em> Current context position */</em>
<a name="87" href="#87">87</a>      <strong>private</strong> <strong>int</strong> position;
<a name="88" href="#88">88</a>  
<a name="89" href="#89">89</a>      <em class="comment">// ----------------------------------------------------------------------</em>
<a name="90" href="#90">90</a>      <em class="comment">//     Constructors</em>
<a name="91" href="#91">91</a>      <em class="comment">// ----------------------------------------------------------------------</em>
<a name="92" href="#92">92</a>  
<a name="93" href="#93">93</a>      <em>/**</em><em> Create a new context.</em>
<a name="94" href="#94">94</a>  <em>     *</em>
<a name="95" href="#95">95</a>  <em>     *  @param contextSupport the context-support</em>
<a name="96" href="#96">96</a>  <em>     */</em>
<a name="97" href="#97">97</a>      <strong>public</strong> <a href="../../org/jaxen/Context.html">Context</a>(<a href="../../org/jaxen/ContextSupport.html">ContextSupport</a> contextSupport)
<a name="98" href="#98">98</a>      {
<a name="99" href="#99">99</a>          <strong>this</strong>.contextSupport = contextSupport;
<a name="100" href="#100">100</a>         <strong>this</strong>.nodeSet        = Collections.EMPTY_LIST;
<a name="101" href="#101">101</a>         <strong>this</strong>.size           = 0;
<a name="102" href="#102">102</a>         <strong>this</strong>.position       = 0;
<a name="103" href="#103">103</a>     }
<a name="104" href="#104">104</a>     
<a name="105" href="#105">105</a>     <em class="comment">// ----------------------------------------------------------------------</em>
<a name="106" href="#106">106</a>     <em class="comment">//     Instance methods</em>
<a name="107" href="#107">107</a>     <em class="comment">// ----------------------------------------------------------------------</em>
<a name="108" href="#108">108</a> 
<a name="109" href="#109">109</a>     <em>/**</em><em> </em>
<a name="110" href="#110">110</a> <em>     * &lt;p></em>
<a name="111" href="#111">111</a> <em>     * Set the context node-set, and sets the current context size to the size </em>
<a name="112" href="#112">112</a> <em>     * of this node-set. &lt;/p></em>
<a name="113" href="#113">113</a> <em>     * </em>
<a name="114" href="#114">114</a> <em>     * &lt;p>The actual list is stored in this object. A copy</em>
<a name="115" href="#115">115</a> <em>     * is not made. This list should not be modified in other code after</em>
<a name="116" href="#116">116</a> <em>     * calling this method.&lt;/p></em>
<a name="117" href="#117">117</a> <em>     *  </em>
<a name="118" href="#118">118</a> <em>     * &lt;p></em>
<a name="119" href="#119">119</a> <em>     * After invoking this method, the client should immediately call </em>
<a name="120" href="#120">120</a> <em>     * {@link #setSize(int) setSize} and {@link #setPosition(int) setPosition}.</em>
<a name="121" href="#121">121</a> <em>     *&lt;/p></em>
<a name="122" href="#122">122</a> <em>     *</em>
<a name="123" href="#123">123</a> <em>     *  @param nodeSet the context node-set</em>
<a name="124" href="#124">124</a> <em>     */</em>
<a name="125" href="#125">125</a>     <strong>public</strong> <strong>void</strong> setNodeSet(List nodeSet)
<a name="126" href="#126">126</a>     {
<a name="127" href="#127">127</a>         <strong>this</strong>.nodeSet = nodeSet;
<a name="128" href="#128">128</a>         <strong>this</strong>.size    = nodeSet.size();
<a name="129" href="#129">129</a>         <strong>if</strong> (position >= size) <strong>this</strong>.position = 0;
<a name="130" href="#130">130</a>     }
<a name="131" href="#131">131</a> 
<a name="132" href="#132">132</a>     <em>/**</em><em> Retrieve the context node-set.</em>
<a name="133" href="#133">133</a> <em>     *  This is a live list. It is not a copy.</em>
<a name="134" href="#134">134</a> <em>     *  Do not modify it.</em>
<a name="135" href="#135">135</a> <em>     *</em>
<a name="136" href="#136">136</a> <em>     *  @return the context node-set</em>
<a name="137" href="#137">137</a> <em>     */</em>
<a name="138" href="#138">138</a>     <strong>public</strong> List getNodeSet()
<a name="139" href="#139">139</a>     {
<a name="140" href="#140">140</a>         <strong>return</strong> <strong>this</strong>.nodeSet;
<a name="141" href="#141">141</a>     }
<a name="142" href="#142">142</a> 
<a name="143" href="#143">143</a>     <em>/**</em><em> Set the &lt;code>ContextSupport&lt;/code>.</em>
<a name="144" href="#144">144</a> <em>     *</em>
<a name="145" href="#145">145</a> <em>     *  @param contextSupport the context-support</em>
<a name="146" href="#146">146</a> <em>     */</em>
<a name="147" href="#147">147</a>     <strong>public</strong> <strong>void</strong> setContextSupport(<a href="../../org/jaxen/ContextSupport.html">ContextSupport</a> contextSupport)
<a name="148" href="#148">148</a>     {
<a name="149" href="#149">149</a>         <strong>this</strong>.contextSupport = contextSupport;
<a name="150" href="#150">150</a>     }
<a name="151" href="#151">151</a> 
<a name="152" href="#152">152</a>     <em>/**</em><em> Retrieve the &lt;code>ContextSupport&lt;/code>.</em>
<a name="153" href="#153">153</a> <em>     *</em>
<a name="154" href="#154">154</a> <em>     *  @return the context-support</em>
<a name="155" href="#155">155</a> <em>     */</em>
<a name="156" href="#156">156</a>     <strong>public</strong> <a href="../../org/jaxen/ContextSupport.html">ContextSupport</a> getContextSupport()
<a name="157" href="#157">157</a>     {
<a name="158" href="#158">158</a>         <strong>return</strong> <strong>this</strong>.contextSupport;
<a name="159" href="#159">159</a>     }
<a name="160" href="#160">160</a> 
<a name="161" href="#161">161</a>     <em>/**</em><em> Retrieve the current &lt;code>Navigator&lt;/code>.</em>
<a name="162" href="#162">162</a> <em>     *</em>
<a name="163" href="#163">163</a> <em>     *  @return the navigator</em>
<a name="164" href="#164">164</a> <em>     */</em>
<a name="165" href="#165">165</a>     <strong>public</strong> <a href="../../org/jaxen/Navigator.html">Navigator</a> getNavigator()
<a name="166" href="#166">166</a>     {
<a name="167" href="#167">167</a>         <strong>return</strong> getContextSupport().getNavigator();
<a name="168" href="#168">168</a>     }
<a name="169" href="#169">169</a> 
<a name="170" href="#170">170</a>     <em>/**</em><em> Translate a namespace prefix to its URI.</em>
<a name="171" href="#171">171</a> <em>     *</em>
<a name="172" href="#172">172</a> <em>     *  @param prefix the prefix</em>
<a name="173" href="#173">173</a> <em>     *</em>
<a name="174" href="#174">174</a> <em>     *  @return the namespace URI mapped to the prefix</em>
<a name="175" href="#175">175</a> <em>     */</em>
<a name="176" href="#176">176</a>     <strong>public</strong> String translateNamespacePrefixToUri(String prefix)
<a name="177" href="#177">177</a>     {
<a name="178" href="#178">178</a>         <strong>return</strong> getContextSupport().translateNamespacePrefixToUri( prefix );
<a name="179" href="#179">179</a>     }
<a name="180" href="#180">180</a> 
<a name="181" href="#181">181</a>     <em>/**</em><em> Retrieve a variable value.</em>
<a name="182" href="#182">182</a> <em>     *</em>
<a name="183" href="#183">183</a> <em>     *  @param namespaceURI the function namespace URI</em>
<a name="184" href="#184">184</a> <em>     *  @param prefix the function prefix</em>
<a name="185" href="#185">185</a> <em>     *  @param localName the function name</em>
<a name="186" href="#186">186</a> <em>     *</em>
<a name="187" href="#187">187</a> <em>     *  @return the variable value</em>
<a name="188" href="#188">188</a> <em>     *</em>
<a name="189" href="#189">189</a> <em>     *  @throws UnresolvableException if unable to locate a bound variable</em>
<a name="190" href="#190">190</a> <em>     */</em>
<a name="191" href="#191">191</a>     <strong>public</strong> Object getVariableValue(String namespaceURI,
<a name="192" href="#192">192</a>                                    String prefix,
<a name="193" href="#193">193</a>                                    String localName)
<a name="194" href="#194">194</a>         throws <a href="../../org/jaxen/UnresolvableException.html">UnresolvableException</a>
<a name="195" href="#195">195</a>     {
<a name="196" href="#196">196</a>         <strong>return</strong> getContextSupport().getVariableValue( namespaceURI,
<a name="197" href="#197">197</a>                                                      prefix,
<a name="198" href="#198">198</a>                                                      localName );
<a name="199" href="#199">199</a>     }
<a name="200" href="#200">200</a> 
<a name="201" href="#201">201</a>     <em>/**</em><em> Retrieve a &lt;code>Function&lt;/code>.</em>
<a name="202" href="#202">202</a> <em>     *</em>
<a name="203" href="#203">203</a> <em>     *  @param namespaceURI the function namespace URI</em>
<a name="204" href="#204">204</a> <em>     *  @param prefix the function prefix</em>
<a name="205" href="#205">205</a> <em>     *  @param localName the function name</em>
<a name="206" href="#206">206</a> <em>     *</em>
<a name="207" href="#207">207</a> <em>     *  @return the function object</em>
<a name="208" href="#208">208</a> <em>     *</em>
<a name="209" href="#209">209</a> <em>     *  @throws UnresolvableException if unable to locate a bound function</em>
<a name="210" href="#210">210</a> <em>     */</em>
<a name="211" href="#211">211</a>     <strong>public</strong> <a href="../../org/jaxen/Function.html">Function</a> getFunction(String namespaceURI,
<a name="212" href="#212">212</a>                                 String prefix,
<a name="213" href="#213">213</a>                                 String localName)
<a name="214" href="#214">214</a>         throws <a href="../../org/jaxen/UnresolvableException.html">UnresolvableException</a>
<a name="215" href="#215">215</a>     {
<a name="216" href="#216">216</a>         <strong>return</strong> getContextSupport().getFunction( namespaceURI,
<a name="217" href="#217">217</a>                                                 prefix,
<a name="218" href="#218">218</a>                                                 localName );
<a name="219" href="#219">219</a>     }
<a name="220" href="#220">220</a> 
<a name="221" href="#221">221</a>     <em class="comment">// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - </em>
<a name="222" href="#222">222</a>     <em class="comment">//     Properties</em>
<a name="223" href="#223">223</a>     <em class="comment">// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - </em>
<a name="224" href="#224">224</a> 
<a name="225" href="#225">225</a>     <em>/**</em><em> Set the current size in the context node-set.</em>
<a name="226" href="#226">226</a> <em>     *</em>
<a name="227" href="#227">227</a> <em>     *  @param size the size</em>
<a name="228" href="#228">228</a> <em>     */</em>
<a name="229" href="#229">229</a>     <strong>public</strong> <strong>void</strong> setSize(<strong>int</strong> size)
<a name="230" href="#230">230</a>     {
<a name="231" href="#231">231</a>         <strong>this</strong>.size = size;
<a name="232" href="#232">232</a>     }
<a name="233" href="#233">233</a> 
<a name="234" href="#234">234</a>     <em>/**</em><em> Retrieve the size of the current context node-set.</em>
<a name="235" href="#235">235</a> <em>     *</em>
<a name="236" href="#236">236</a> <em>     *  @return the size</em>
<a name="237" href="#237">237</a> <em>     */</em>
<a name="238" href="#238">238</a>     <strong>public</strong> <strong>int</strong> getSize()
<a name="239" href="#239">239</a>     {
<a name="240" href="#240">240</a>         <strong>return</strong> <strong>this</strong>.size;
<a name="241" href="#241">241</a>     }
<a name="242" href="#242">242</a> 
<a name="243" href="#243">243</a>     <em>/**</em><em> Set the current position in the context node-set.</em>
<a name="244" href="#244">244</a> <em>     *</em>
<a name="245" href="#245">245</a> <em>     *  @param position the position</em>
<a name="246" href="#246">246</a> <em>     */</em>
<a name="247" href="#247">247</a>     <strong>public</strong> <strong>void</strong> setPosition(<strong>int</strong> position)
<a name="248" href="#248">248</a>     {
<a name="249" href="#249">249</a>         <strong>this</strong>.position = position;
<a name="250" href="#250">250</a>     }
<a name="251" href="#251">251</a> 
<a name="252" href="#252">252</a>     <em>/**</em><em> Retrieve current position in the context node-set.</em>
<a name="253" href="#253">253</a> <em>     *</em>
<a name="254" href="#254">254</a> <em>     *  @return the current position</em>
<a name="255" href="#255">255</a> <em>     */</em>
<a name="256" href="#256">256</a>     <strong>public</strong> <strong>int</strong> getPosition()
<a name="257" href="#257">257</a>     {
<a name="258" href="#258">258</a>         <strong>return</strong> <strong>this</strong>.position;
<a name="259" href="#259">259</a>     }
<a name="260" href="#260">260</a> 
<a name="261" href="#261">261</a>     <em class="comment">// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - </em>
<a name="262" href="#262">262</a>     <em class="comment">//     Helpers</em>
<a name="263" href="#263">263</a>     <em class="comment">// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - </em>
<a name="264" href="#264">264</a> 
<a name="265" href="#265">265</a>     <em>/**</em><em> Create a type-safe shallow copy.</em>
<a name="266" href="#266">266</a> <em>     *</em>
<a name="267" href="#267">267</a> <em>     *  @return the duplicate</em>
<a name="268" href="#268">268</a> <em>     */</em>
<a name="269" href="#269">269</a>     <strong>public</strong> <a href="../../org/jaxen/Context.html">Context</a> duplicate()
<a name="270" href="#270">270</a>     {
<a name="271" href="#271">271</a>         <a href="../../org/jaxen/Context.html">Context</a> dupe = <strong>new</strong> <a href="../../org/jaxen/Context.html">Context</a>( getContextSupport() );
<a name="272" href="#272">272</a> 
<a name="273" href="#273">273</a>         List thisNodeSet = getNodeSet();
<a name="274" href="#274">274</a> 
<a name="275" href="#275">275</a>         <strong>if</strong> ( thisNodeSet != <strong>null</strong> )
<a name="276" href="#276">276</a>         {
<a name="277" href="#277">277</a>             List dupeNodeSet = <strong>new</strong> ArrayList( thisNodeSet.size() );
<a name="278" href="#278">278</a>             dupeNodeSet.addAll( thisNodeSet );
<a name="279" href="#279">279</a>             dupe.setNodeSet( dupeNodeSet );
<a name="280" href="#280">280</a>             dupe.setPosition(<strong>this</strong>.position);
<a name="281" href="#281">281</a>         }
<a name="282" href="#282">282</a> 
<a name="283" href="#283">283</a>         <strong>return</strong> dupe;
<a name="284" href="#284">284</a>     }
<a name="285" href="#285">285</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

